Xbasic

A5_DISPLAYHELPTOPIC Function

Syntax

Result_Flag as L = a5_DisplayHelpTopic(C topic [,C topic_type [,C chmfile ]])

Arguments

Result_Flag

.T. = Topic was found .F. = Topic was not found

topic

The topic or index entry to use to retrieve a page from the help text. A table of contents reference must contain both the folder and filename of the topic. Note : To position the cursor to a topic and bookmark, append " #bookmark_name " after the ".htm ". Note : References to index entries must be top level entries.

topic_type

Character. Optional. Default = "index_entry". "toc" = match table of contents entry "index_entry" = match index entry

chmfile

Optional. The default name and location for the webhelp is "http://support.alphasoftware.com/alphafivehelp/index.htm". The CHM file is in the Alpha Anywhere program folder. Character

Description

The A5_DISPLAYHELPTOPIC() function attempts to retrieve the selected topic from either the local compiled help file (.CHM format) stored in the Alpha Anywhere program directory or from the webhelp located at Help_Project. The choice is made by the user setting specified under Help > Help Source. Source is .chm or Web depending on help preference

Help Source
Query Mode
AlphaFiveHelp.chm

Table of Contents, Index Entry

Webhelp

Table of Contents, Index Entry

Example

? a5_displayhelptopic("table_get() ", "index_entry")
= .T.
? a5_displayhelptopic("User_Manual/Renaming_and_Deleting_Databases.htm", "toc")
= .T.

Limitations

Desktop applications only.

See Also